inclinometer4.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef INCLINOMETER4_H
#define INCLINOMETER4_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"




#define INCLINOMETER4_REG_INT_STATUS                0x00
#define INCLINOMETER4_REG_TEMP_OUT                  0x01
#define INCLINOMETER4_REG_VECM_LSB                  0x02
#define INCLINOMETER4_REG_VECM_MSB                  0x03
#define INCLINOMETER4_REG_OUT_X_LSB                 0x04
#define INCLINOMETER4_REG_OUT_X_MSB                 0x05
#define INCLINOMETER4_REG_OUT_Y_LSB                 0x06
#define INCLINOMETER4_REG_OUT_Y_MSB                 0x07
#define INCLINOMETER4_REG_OUT_Z_LSB                 0x08
#define INCLINOMETER4_REG_OUT_Z_MSB                 0x09
#define INCLINOMETER4_REG_BUF_STATUS                0x0B
#define INCLINOMETER4_REG_BUF_X_LSB                 0x0C
#define INCLINOMETER4_REG_BUF_X_MSB                 0x0D
#define INCLINOMETER4_REG_BUF_Y_LSB                 0x0E
#define INCLINOMETER4_REG_BUF_Y_MSB                 0x0F
#define INCLINOMETER4_REG_BUF_Z_LSB                 0x10
#define INCLINOMETER4_REG_BUF_Z_MSB                 0x11
#define INCLINOMETER4_REG_PROD_REV                  0x12
#define INCLINOMETER4_REG_WHO_AM_I                  0x13
#define INCLINOMETER4_REG_SYS_MODE                  0x14
#define INCLINOMETER4_REG_SENS_CONFIG1              0x15
#define INCLINOMETER4_REG_SENS_CONFIG2              0x16
#define INCLINOMETER4_REG_SENS_CONFIG3              0x17
#define INCLINOMETER4_REG_SENS_CONFIG4              0x18
#define INCLINOMETER4_REG_SENS_CONFIG5              0x19
#define INCLINOMETER4_REG_WAKE_IDLE_LSB             0x1A
#define INCLINOMETER4_REG_WAKE_IDLE_MSB             0x1B
#define INCLINOMETER4_REG_SLEEP_IDLE_LSB            0x1C
#define INCLINOMETER4_REG_SLEEP_IDLE_MSB            0x1D
#define INCLINOMETER4_REG_ASLP_COUNT_LSB            0x1E
#define INCLINOMETER4_REG_ASLP_COUNT_MSB            0x1F
#define INCLINOMETER4_REG_INT_EN                    0x20
#define INCLINOMETER4_REG_INT_PIN_SEL               0x21
#define INCLINOMETER4_REG_OFF_X                     0x22
#define INCLINOMETER4_REG_OFF_Y                     0x23
#define INCLINOMETER4_REG_OFF_Z                     0x24
#define INCLINOMETER4_REG_BUF_CONFIG1               0x26
#define INCLINOMETER4_REG_BUF_CONFIG2               0x27
#define INCLINOMETER4_REG_ORIENT_STATUS             0x28
#define INCLINOMETER4_REG_ORIENT_CONFIG             0x29
#define INCLINOMETER4_REG_ORIENT_DBCOUNT            0x2A
#define INCLINOMETER4_REG_ORIENT_BF_ZCOMP           0x2B
#define INCLINOMETER4_REG_ORIENT_THS_REG            0x2C
#define INCLINOMETER4_REG_SDCD_INT_SRC1             0x2D
#define INCLINOMETER4_REG_SDCD_INT_SRC2             0x2E
#define INCLINOMETER4_REG_SDCD_CONFIG1              0x2F
#define INCLINOMETER4_REG_SDCD_CONFIG2              0x30
#define INCLINOMETER4_REG_SDCD_OT_DBCNT             0x31
#define INCLINOMETER4_REG_SDCD_WT_DBCNT             0x32
#define INCLINOMETER4_REG_SDCD_LTHS_LSB             0x33
#define INCLINOMETER4_REG_SDCD_LTHS_MSB             0x34
#define INCLINOMETER4_REG_SDCD_UTHS_LSB             0x35
#define INCLINOMETER4_REG_SDCD_UTHS_MSB             0x36
#define INCLINOMETER4_REG_SELF_TEST_CONFIG1         0x37
#define INCLINOMETER4_REG_SELF_TEST_CONFIG2         0x38
 // inclinometer4_reg



#define INCLINOMETER4_INT_STATUS_SRC_DRDY           0x80
#define INCLINOMETER4_INT_STATUS_SRC_OVF            0x40
#define INCLINOMETER4_INT_STATUS_SRC_BUF            0x20
#define INCLINOMETER4_INT_STATUS_SRC_SDCD_OT        0x10
#define INCLINOMETER4_INT_STATUS_SRC_SDCD_WT        0x08
#define INCLINOMETER4_INT_STATUS_SRC_ORIENT         0x04
#define INCLINOMETER4_INT_STATUS_SRC_ASLP           0x02
#define INCLINOMETER4_INT_STATUS_SRC_BOOT           0x01

#define INCLINOMETER4_WHO_AM_I                      0x83

#define INCLINOMETER4_SENS_CONFIG1_RST              0x80
#define INCLINOMETER4_SENS_CONFIG1_ST_AXIS_SEL_DIS  0x00
#define INCLINOMETER4_SENS_CONFIG1_ST_AXIS_SEL_X    0x20
#define INCLINOMETER4_SENS_CONFIG1_ST_AXIS_SEL_Y    0x40
#define INCLINOMETER4_SENS_CONFIG1_ST_AXIS_SEL_Z    0x60
#define INCLINOMETER4_SENS_CONFIG1_ST_AXIS_SEL_MASK 0x60
#define INCLINOMETER4_SENS_CONFIG1_ST_POL           0x10
#define INCLINOMETER4_SENS_CONFIG1_SPI_M_4_WIRE     0x00
#define INCLINOMETER4_SENS_CONFIG1_SPI_M_3_WIRE     0x08
#define INCLINOMETER4_SENS_CONFIG1_SPI_M_MASK       0x08
#define INCLINOMETER4_SENS_CONFIG1_FSR_2G           0x00
#define INCLINOMETER4_SENS_CONFIG1_FSR_4G           0x02
#define INCLINOMETER4_SENS_CONFIG1_FSR_8G           0x04
#define INCLINOMETER4_SENS_CONFIG1_FSR_16G          0x06
#define INCLINOMETER4_SENS_CONFIG1_FSR_MASK         0x06
#define INCLINOMETER4_SENS_CONFIG1_MODE_STANDBY     0x00
#define INCLINOMETER4_SENS_CONFIG1_MODE_ACTIVE      0x01
#define INCLINOMETER4_SENS_CONFIG1_MODE_MASK        0x01

#define INCLINOMETER4_SENS_CONFIG3_WAKE_ODR_MASK    0xF0
#define INCLINOMETER4_SENS_CONFIG3_SLEEP_ODR_MASK   0x0F

#define INCLINOMETER4_SENS_CONFIG4_EXT_TRIG_M       0x80
#define INCLINOMETER4_SENS_CONFIG4_WAKE_SDCD_WT     0x40
#define INCLINOMETER4_SENS_CONFIG4_WAKE_SDCD_OT     0x20
#define INCLINOMETER4_SENS_CONFIG4_WAKE_ORIENT      0x10
#define INCLINOMETER4_SENS_CONFIG4_DRDY_PUL         0x08
#define INCLINOMETER4_SENS_CONFIG4_INT2_FUNC        0x04
#define INCLINOMETER4_SENS_CONFIG4_INT_PP_OD        0x02
#define INCLINOMETER4_SENS_CONFIG4_INT_POL          0x01

#define INCLINOMETER4_INT_EN_DRDY                   0x80
#define INCLINOMETER4_INT_EN_BUF                    0x40
#define INCLINOMETER4_INT_EN_SDCD_OT                0x20
#define INCLINOMETER4_INT_EN_SDCD_WT                0x10
#define INCLINOMETER4_INT_EN_ORIENT                 0x08
#define INCLINOMETER4_INT_EN_ASLP                   0x04
#define INCLINOMETER4_INT_EN_BOOT_DIS               0x02
#define INCLINOMETER4_INT_EN_WAKE_OUT               0x01

#define INCLINOMETER4_INT_PIN_SEL_DRDY_INT2         0x80
#define INCLINOMETER4_INT_PIN_SEL_BUF_INT2          0x40
#define INCLINOMETER4_INT_PIN_SEL_SDCD_OT_INT2      0x20
#define INCLINOMETER4_INT_PIN_SEL_SDCD_WT_INT2      0x10
#define INCLINOMETER4_INT_PIN_SEL_ORIENT_INT2       0x08
#define INCLINOMETER4_INT_PIN_SEL_ASLP_INT2         0x04
#define INCLINOMETER4_INT_PIN_SEL_BOOT_INT2         0x02
#define INCLINOMETER4_INT_PIN_SEL_WAKE_OUT_INT2     0x01

#define INCLINOMETER4_MODE_STANDBY                  0
#define INCLINOMETER4_MODE_ACTIVE                   1

#define INCLINOMETER4_FSR_2G                        0
#define INCLINOMETER4_FSR_4G                        1
#define INCLINOMETER4_FSR_8G                        2
#define INCLINOMETER4_FSR_16G                       3

#define INCLINOMETER4_ODR_3200_HZ                   0
#define INCLINOMETER4_ODR_1600_HZ                   1
#define INCLINOMETER4_ODR_800_HZ                    2
#define INCLINOMETER4_ODR_400_HZ                    3
#define INCLINOMETER4_ODR_200_HZ                    4
#define INCLINOMETER4_ODR_100_HZ                    5
#define INCLINOMETER4_ODR_50_HZ                     6
#define INCLINOMETER4_ODR_25_HZ                     7
#define INCLINOMETER4_ODR_12_5_HZ                   8
#define INCLINOMETER4_ODR_6_25_HZ                   9
#define INCLINOMETER4_ODR_3_125_HZ                  10
#define INCLINOMETER4_ODR_1_563_HZ                  11
#define INCLINOMETER4_ODR_0_781_HZ                  12

#define INCLINOMETER4_LSB_PER_G_FSR_2G              1024
#define INCLINOMETER4_LSB_PER_G_FSR_4G              512
#define INCLINOMETER4_LSB_PER_G_FSR_8G              256
#define INCLINOMETER4_LSB_PER_G_FSR_16G             128

#define INCLINOMETER4_TEMP_OFFSET                   25

#define INCLINOMETER4_DEVICE_ADDRESS_0              0x18
#define INCLINOMETER4_DEVICE_ADDRESS_1              0x19

#define INCLINOMETER4_SET_DATA_SAMPLE_EDGE          SET_SPI_DATA_SAMPLE_EDGE
#define INCLINOMETER4_SET_DATA_SAMPLE_MIDDLE        SET_SPI_DATA_SAMPLE_MIDDLE
 // inclinometer4_set



#define INCLINOMETER4_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.int2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.int1 = MIKROBUS( mikrobus, MIKROBUS_INT )
 // inclinometer4_map // inclinometer4

typedef enum
{
    INCLINOMETER4_DRV_SEL_SPI,      
    INCLINOMETER4_DRV_SEL_I2C       
 
} inclinometer4_drv_t;

struct inclinometer4_s;
typedef err_t ( *inclinometer4_master_io_t )( struct inclinometer4_s*, uint8_t, uint8_t*, uint8_t ); 

typedef struct inclinometer4_s
{
    digital_in_t int2;                  
    digital_in_t int1;                  
 
    i2c_master_t i2c;                   
    spi_master_t spi;                   
 
    uint8_t slave_address;              
    pin_name_t chip_select;             
    inclinometer4_drv_t drv_sel;        
 
    inclinometer4_master_io_t write_f;  
    inclinometer4_master_io_t read_f;   
 
    uint16_t lsb_per_g;                 
 
} inclinometer4_t;

typedef struct
{
    pin_name_t scl;                     
    pin_name_t sda;                     
    pin_name_t miso;                    
    pin_name_t mosi;                    
    pin_name_t sck;                     
    pin_name_t cs;                      
    pin_name_t int2;                    
    pin_name_t int1;                    
 
    uint32_t   i2c_speed;               
    uint8_t    i2c_address;             
 
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
 
    inclinometer4_drv_t drv_sel;        
 
} inclinometer4_cfg_t;

typedef struct
{
    float x;                            
    float y;                            
    float z;                            
    int8_t temperature;                 
 
} inclinometer4_data_t;

typedef enum
{
    INCLINOMETER4_OK = 0,
    INCLINOMETER4_ERROR = -1
 
} inclinometer4_return_value_t;


void inclinometer4_cfg_setup ( inclinometer4_cfg_t *cfg );

void inclinometer4_drv_interface_sel ( inclinometer4_cfg_t *cfg, inclinometer4_drv_t drv_sel );

err_t inclinometer4_init ( inclinometer4_t *ctx, inclinometer4_cfg_t *cfg );

err_t inclinometer4_default_cfg ( inclinometer4_t *ctx );

err_t inclinometer4_write_regs ( inclinometer4_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );

err_t inclinometer4_read_regs ( inclinometer4_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );

err_t inclinometer4_write_reg ( inclinometer4_t *ctx, uint8_t reg, uint8_t data_in );

err_t inclinometer4_read_reg ( inclinometer4_t *ctx, uint8_t reg, uint8_t *data_out );

uint8_t inclinometer4_get_int1_pin ( inclinometer4_t *ctx );

uint8_t inclinometer4_get_int2_pin ( inclinometer4_t *ctx );

err_t inclinometer4_check_comm ( inclinometer4_t *ctx );

err_t inclinometer4_get_status ( inclinometer4_t *ctx, uint8_t *status );

err_t inclinometer4_sw_reset ( inclinometer4_t *ctx );

err_t inclinometer4_set_mode ( inclinometer4_t *ctx, uint8_t mode );

err_t inclinometer4_set_fsr ( inclinometer4_t *ctx, uint8_t fsr );

err_t inclinometer4_set_odr ( inclinometer4_t *ctx, uint8_t odr );

err_t inclinometer4_get_data ( inclinometer4_t *ctx, inclinometer4_data_t *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // INCLINOMETER4_H
 // inclinometer4
 
// ------------------------------------------------------------------------ END